au PAY（ネット支払い）アプリ方式利用承諾API一覧（随時決済）

au PAY（ネット支払い）アプリ方式利用承諾 API一覧

HTTP仕様（.idPass）

HTTP仕様（.json）

Request header		Content-Type: application/x-www-form-urlencoded;charset=windows-31j
Method		POST
Response header		Content-Type: text/plain;charset=windows-31j
Status Code		200：常に200を返却

Request header		Content-Type: application/json;charset=UTF-8
Method		POST
Response header		Content-Type: application/json;charset=UTF-8
Status Code		200：正常時 400：入力パラメータエラー、加盟店設定エラー 500：システムエラー 502：決済エラー　　　　　　　 ※以下のエラーコードはhttp200で返却される可能性がございます。　・E90010001 　・E92000001 　・E92000002 　・E91099996 　・E91099997

EntryTranAupayAppAccept 取引登録

これ以降の利用承諾で必要となる取引IDと取引パスワードの発行を行い、取引を開始します。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
OrderID	orderID	必須半角英数記号27桁オーダーID 加盟店様が取引を識別するための値を設定します。

URL

/payment/EntryTranAupayAppAccept.json

リクエストパラメータ

{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "orderID": "ORDER0000001"
}

URL

/payment/EntryTranAupayAppAccept.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001

レスポンス

正常

AccessID		accessID		必須半角英数32桁固定取引ID
AccessPass		accessPass		必須半角英数32桁固定取引パスワード

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
    "accessID":"a6a6b0061347e90cdef806b39bd28705",
    "accessPass":"5e0e54b892e14ed03e8cf807a6053813"
}

レスポンスパラメータ：正常系

AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813

レスポンスパラメータ：異常系

[
    {
        "errCode":"E01",
        "errInfo":"E01040001" 
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

ExecTranAupayAppAccept 決済実行

これ以降の処理で必要となるトークンを返却します。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
AccessID	accessID	必須半角英数32桁固定取引ID
AccessPass	accessPass	必須半角英数32桁固定取引パスワード
OrderID	orderID	必須半角英数記号27桁オーダーID
ClientField1	clientField1	全半角100バイト加盟店自由項目1
ClientField2	clientField2	全半角100バイト加盟店自由項目2
ClientField3	clientField3	全半角100バイト加盟店自由項目3
RetURL	retURL	必須半角英数記号256桁利用承諾結果戻しURL 加盟店様が当サービスからの利用承諾結果を受信する為の結果受信URLを設定します。 au PAY上でお客様が認証、支払操作をキャンセルした場合や、当サービスにて決済処理を実行した場合に指定されたURLに結果をリダイレクト経由で送信されます。
PaymentTermSec	paymentTermSec	半角数字5桁支払開始期限秒お客様が【決済実行】から【利用承諾開始IF】を呼び出すまでの期限です。最大86,400秒（1日）呼び出しパラメータが空の場合、120秒で処理されます。
MerchantName	merchantName	必須全半角50桁 QR決済加盟店名 au PAY利用承諾画面で加盟店名として表示されます。

URL

/payment/ExecTranAupayAppAccept.json

リクエストパラメータ

{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
  "orderID": "ORDER0000001",
  "retURL": "https://example.com/receive",
  "merchantName": "テスト加盟店"
}

URL

/payment/ExecTranAupayAppAccept.idPass

リクエストパラメータ

  ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&RetURL=https://example.com/receive&MerchantName=テスト加盟店

レスポンス

正常

AccessID	accessID	半角英数32桁固定取引ID
Token	token	半角英数256桁固定トークン
StartURL	startURL	半角英数記号256桁利用承諾開始IFのURL 利用承諾開始IFのURLを返却します。
StartLimitDate	startLimitDate	半角数字14桁固定支払開始期限日時

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "token": "f412700492fa72b4bb7aad3962fc8a121e46bc797ddcebe58847e59595f1b276",
  "startURL": "https://x01.mul-pay.jp/payment/AupayAppAcceptStart.idPass",
  "startLimitDate": "20231128204505"
}

レスポンスパラメータ：正常系

AccessID=a6a6b0061347e90cdef806b39bd28705&Token=qlxcMlmNXu+YJoAPr0zIiHoG/KrcaJJkTVUEeuYe67E3Vh427rKZBJphG0D2YhAL&StartURL=https://x01.mul-pay.jp/payment/AupayAppAcceptStart.idPass&StartLimitDate=20231212162711

レスポンスパラメータ：異常系

[
    {
        "errCode":"E01",
        "errInfo":"E01040001" 
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

AupayAppAcceptStart 利用承諾開始IF呼び出し

au PAY利用承諾画面を表示させます。

リクエスト

AccessID		必須半角英数32桁固定取引ID
Token		必須半角英数記号256桁固定トークン

URL

/payment/AupayAppAcceptStart.idPass

リクエストパラメータ

AccessID=a6a6b0061347e90cdef806b39bd28705&Token=f412700492fa72b4bb7aad3962fc8a121e46bc797ddcebe58847e59595f1b276

リダイレクトページサンプル


<html>
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=Windows-31J">
  </head>
  <body>
    <form name=""AupayAppAcceptStartCall" action="{AupayAppAcceptStartURL}" method="POST">
    <noscript>
      <br>
      <br>
      <center>
        <h2>
          au PAYの利用承諾画面へ遷移します。
        </h2>
        <input type="submit" value="続行">
      </center>
      </noscript>
      <input type="hidden" name="AccessID" value="{AccessID}">
      <input type="hidden" name="Token" value="{Token}">
    </form>
    <script>
    <!--
      function OnLoadEvent() {
        document.AupayAppAcceptStartCall.submit();
      }
    //-->
    </script>
    </body>
</html>

利用承諾結果受信

au PAYから、当サービスに認証・利用承諾結果が通知されます。
認証・利用承諾結果は、お客様が操作を完了した場合と認証・操作をキャンセルした場合に通知されます。
当サービスは、【決済実行】時に指定されたリダイレクトURLに利用承諾結果を通知します。
この利用承諾結果は、au PAYの利用承諾完了画面からブラウザ経由で連携されるため、ユーザの操作方法によっては操作が完了したにもかかわらず、加盟店様に通知されないことがあります。その際はショップ管理画面または結果通知にて確認ください。
また、同様の理由でこの利用承諾結果が複数回加盟店様に通知されることがあります。

レスポンス

正常

ShopID		必須半角英数13桁ショップID
OrderID		必須半角英数記号27桁オーダーID
Status		必須現状態該当取引の取引状態を返却します。 REGISTER：利用承諾 PAYFAIL：決済失敗
TranDate		必須半角数字14桁固定処理日時当サービスで処理を実施した日時を返却します。 yyyyMMddHHmmss書式
AuAcceptCode		必須半角数字20桁 au承諾番号
CheckString		必須半角英数32桁改ざんチェック文字列 OrderID,AccessID,ShopID,ShopPass,Statusを連結しMD5ハッシュした値を返却します。

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

AupayAppAcceptEnd 利用承諾終了

利用承諾の終了を行います。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
AccessID	accessID	必須半角英数32桁固定取引ID
AccessPass	accessPass	必須半角英数32桁固定取引パスワード
OrderID	orderID	必須半角英数記号27桁オーダーID
AuAcceptCode	auAcceptCode	必須半角英数20桁 au承諾番号

URL

/payment/AupayAppAcceptEnd.json

リクエストパラメータ

{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
  "orderID": "ORDER0000001",
  "AuAcceptCode": "12345678901234567890"
}

URL

/payment/AupayAppAcceptEnd.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&AuAcceptCode=12345678901234567890

レスポンス

正常

OrderID		orderID		半角英数記号27桁オーダーID
Status		status		現状態処理成功時は以下のステータスが返却されます。・END：利用承諾終了

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
  "orderID": "ORDER0000001",
  "status": "END"
}

レスポンスパラメータ：正常系

OrderID=ORDER0000001&Status=END

レスポンスパラメータ：異常系

[
    {
        "errCode":"E01",
        "errInfo":"E01040001" 
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

SearchTradeAupayAppAccept/SearchTradeMulti 取引状態参照

対象取引の取引状態を取得します。
※SearchTradeMultiはidPass版にのみ対応しています。json版には対応しておりません。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
OrderID	orderID	必須半角英数記号27桁オーダーID
PayType	payType	半角数字2桁決済方法 SearchTradeMultiをご利用の際は「54」を指定してください。 SearchTradeAupayAppAcceptをご利用の際は設定不要です。

URL

/payment/SearchTradeAupayAppAccept.json

リクエストパラメータ

{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "orderID": "ORDER0000001"
}

URL：SearchTradeAupayAppAcceptの場合

/payment/SearchTradeAupayAppAccept.idPass

URL：SearchTradeMultiの場合

/payment/SearchTradeMulti.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001

レスポンス

正常

Status	status	現状態 UNPROCESSED：未決済 REQSUCCESS：要求成功 AUTHPROCESS：認証処理中 PAYFAIL：決済失敗 REGISTER：利用承諾 END：利用承諾終了
ProcessDate	processDate	半角数字14桁固定処理日時処理を実施した日時を返却します。 yyyyMMddHHmmss書式
JobCd	jobCd	処理区分 REGISTER：利用承諾 END：利用承諾終了
AccessID	accessID	半角英数32桁固定取引ID
AccessPass	accessPass	半角英数32桁固定取引パスワード
ClientField1	clientField1	全半角100バイト加盟店自由項目1
ClientField2	clientField2	全半角100バイト加盟店自由項目2
ClientField3	clientField3	全半角100バイト加盟店自由項目3
PayType	payType	半角数字2桁決済方法 54：au PAY（アプリ方式）（利用承諾）
AuAcceptCode	auAcceptCode	半角英数20桁 au承諾番号

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
  "status": "REGISTER",
  "processDate": "20190213200436",
  "jobCd": "REGISTER",
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
  "clientField1": "",
  "clientField2": "",
  "clientField3": "",
  "payType": "54",
  "auAcceptCode": "12345678901234567890"
}

レスポンスパラメータ：正常系

Status=REGISTER&ProcessDate=20190213200436&JobCd=REGISTER&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&ClientField1=&ClientField2=&ClientField3=&PayType=54&AuAcceptCode=12345678901234567890

レスポンスパラメータ：異常系

[
    {
        "errCode":"E01",
        "errInfo":"E01040001" 
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001